AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The interface for an HTTP request that is agnostic of the underlying HTTP API.

Inheritance Hierarchy

Amazon.Runtime.IHttpRequest<>

Namespace: Amazon.Runtime
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z

Syntax

C# 
public interface IHttpRequest<>
         IDisposable

The IHttpRequest<> type exposes the following members

Properties

NameTypeDescription
Public Property HttpProtocolVersion System.Version

The version of the HTTP protocol to use. The default is HTTP 1.1.

Public Property Method System.String

The HTTP method or verb.

Public Property RequestUri System.Uri

The request URI.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.7.2 or higher.

NameDescription
Public Method Abort()

Aborts the HTTP request.

Public Method ConfigureRequest(IRequestContext)

Configures a request as per the request context.

Public Method GetRequestContent()

Gets a handle to the request content.

Public Method GetRequestContentAsync()

Gets a handle to the request content.

Public Method GetRequestContentAsync(CancellationToken)
Public Method GetResponse()

Returns the HTTP response.

Public Method GetResponseAsync(CancellationToken)

Returns the HTTP response.

Public Method SetRequestHeaders(IDictionary<String, String>)

Sets the headers on the request.

Public Method SetupHttpRequestStreamPublisher(IDictionary<String, String>, IHttpRequestStreamPublisher)

Configures the HttpRequest for streaming data to the service after the initial request is complete. Data is pulled from publisher which eventually connects back to the consumer of the SDK and streamed to the service.

Public Method SetupProgressListeners(Stream, Int64, object, EventHandler<StreamTransferProgressArgs>)

Sets up the progress listeners

Public Method WriteToRequestBody(TRequestContent, Stream, IDictionary<String, String>, IRequestContext)

Writes a stream to the request body.

Public Method WriteToRequestBody(TRequestContent, Byte[], IDictionary<String, String>)

Writes a byte array to the request body.

Public Method WriteToRequestBodyAsync(TRequestContent, Stream, IDictionary<String, String>, IRequestContext)
Public Method WriteToRequestBodyAsync(TRequestContent, Byte[], IDictionary<String, String>, CancellationToken)

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer